home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / mtx_101.zip / MTX-D.ZIP / TEXTDOOR.DOC < prev    next >
Text File  |  1990-10-25  |  9KB  |  267 lines
  1.  
  2. Documentation for the Mycroft Text Door
  3. =======================================
  4.  
  5. The Mycroft Text Door is a simple door program that allows you to run to
  6. display text files, both b/w and color, from a menu based environment.  You
  7. may display up to 45 different pairs of text files using this door.  TextDoor
  8. is invoked using the following command line:
  9.  
  10.                           TEXTDOOR
  11.                           TEXTDOOR node path bbs
  12.  
  13. The first line will run TextDoor in local mode.  The second line runs
  14. TextDoor in remote mode and the 'node' parameter represents the BBS node that
  15. is running, the 'path' is the full drive and path to your BBS files, and the
  16. 'bbs' is your BBS type as described below.
  17.  
  18. Well, I hope you enjoy the program.  If you have any questions or comments,
  19. please feel free to leave them on Mycroft Systems (408)927-0105.
  20.  
  21.  
  22. File list:
  23. ==========
  24.  
  25.         TEXTDOOR.DOC  -  This Document.
  26.         TEXTDOOR.BAT  -  Sample batch file to execute under Quick BBS.
  27.         TEXTDOOR.EXE  -  The executible program (will run stand-alone).
  28.         TEXTDOOR.CFG  -  Mycroft Text Door configuration file.
  29.         TXSAMPLE.BUL  -  Sample text file (B/W).
  30.         TXSAMPLE.CLR  -  Sample text file (Color).
  31.         NODES.BBS     -  A list of your comm port assignments by BBS node.
  32.         PORTS.BBS     -  Port definition file (optional & described within).
  33.  
  34.  
  35.  
  36. Program history:
  37. ================
  38.  
  39. 10/90   Version 1.00  -  Initial version
  40.  
  41.  
  42. Config File Format:
  43. ===================
  44.  
  45. The following is the format of the TEXTDOOR.CFG file:
  46.  
  47.       Line 1 - Name of your BBS.
  48.                Up to 80 characters.
  49.       Line 2 - SysOps name.
  50.                Up to 80 characters.
  51.       Line 3 - Starting color flag.
  52.                0 = Color off
  53.                1 = Color on
  54.       Line 4 - Color to use.
  55.                31 = Red.
  56.                32 = Green.
  57.                33 = Yellow.
  58.                34 = Blue.
  59.                35 = Magenta.
  60.                36 = Cyan.
  61.                37 = White.
  62.       Line 5 - Number of menu columns.
  63.                May be from 1 to 7.
  64.       Line 6 - Menu title
  65.                Up to 80 characters.
  66.       Line 7 - TextFile control line 1.
  67.          .              .
  68.          .              .
  69.          .              .
  70.       Line n - TextFile control line n.
  71.  
  72. Each TextFile control line consists of 3 items.  The first item is the name of
  73. the b/w display file.  The second item is the name of the color display file.
  74. Both items 1 and 2 may be either complete drive:\path\filename.ext file
  75. specifications or they may be relative file specifications.  Both items 1 and 2
  76. must be single words with no spaces or tabs imbedded in them.  They are both
  77. limited to 40 characters.  The remainder of the line is considered the Menu
  78. Text to be displayed by the program.  This is limited based on the number of
  79. menu columns.  The following lists the limitations on menu text based on the
  80. number of columns:
  81.  
  82.                         COLUMNS         MENU TEXT SIZE
  83.                        ---------       ----------------
  84.                            1                  60
  85.                            2                  30
  86.                            3                  20
  87.  
  88. The maximum number of TextFile control lines is also dependant on the number
  89. of columns.  The maximum number of TextFile control lines based on the number
  90. of columns is:
  91.  
  92.                           COLUMNS         MENU ITEMS
  93.                          ---------       ------------
  94.                              1                  15
  95.                              2                  30
  96.                              3                  45
  97.  
  98.  
  99. BBS Specific Operation:
  100. =======================
  101.  
  102. Opinion supports the follow BBS type parameters:
  103.  
  104.       RBBS      for RBBS 16.1 or newer
  105.       QBBS      for Quick BBS
  106.       PCBOARD   for PC-Board 12.1
  107.       PCBOARD14 for PC-Board 14.x
  108.       WILDCAT   for Wildcat BBS
  109.       GAP       for GAP BBS
  110.       WWIV      for WWIV BBS
  111.       SPITFIRE  for Spitfire BBS (door)
  112.       SPITFIREK for Spitfire BBS (Main Menu User Command)
  113.       SPITFIREM for Spitfire BBS (Message Menu User Command)
  114.       SPITFIREF for Spitfire BBS (File Menu User Command)
  115.  
  116.  
  117. Assumed RBBS 16.x files:
  118. ------------------------
  119.  
  120. Opinion assumes that the following files are in the directory specified
  121. by the path parameter when running directly under RBBS 16.x:
  122.  
  123.         NODES.BBS       Node definition file.
  124.  
  125.         MESSAGES        This file contains the information pertaining
  126.                         to each node on the BBS.
  127.  
  128.         DORINFOx.DEF    This file contains all of the users settings
  129.                         such as graphics, parity, baud rate, etc.
  130.  
  131.  
  132. Assumed Quick BBS files:
  133. ========================
  134.  
  135. Opinion assumes that the following files are in the directory specified
  136. by the path parameter when running directly under Quick BBS:
  137.  
  138.         NODES.BBS       Node definition file.
  139.  
  140.         DORINFOx.DEF    This file contains all of the users settings
  141.                         such as graphics, parity, baud rate, etc.
  142.  
  143.  
  144. Assumed PC-BOARD files:
  145. =======================
  146.  
  147. Opinion assumes that the following files are in the directory specified
  148. by the path parameter when running directly under PC-Board:
  149.  
  150.         NODES.BBS       Node definition file.
  151.  
  152.         PCBOARD.SYS     This file contains the information pertaining
  153.                         to the BBS node and the callers information.
  154.  
  155.  
  156.  
  157. Assumed Wildcat files:
  158. ======================
  159.  
  160. Opinion assumes that the following files are in the directory specified
  161. by the path parameter when running directly under Wildcat:
  162.  
  163.         NODES.BBS       Node definition file.
  164.  
  165.         CALLINFO.BBS    This file contains all of the users settings
  166.                         such as graphics, parity, baud rate, etc.
  167.  
  168.  
  169.  
  170. Assumed GAP files:
  171. ==================
  172.  
  173. Opinion assumes that the following files are in the directory specified
  174. by the path parameter when running directly under GAP:
  175.  
  176.         NODES.BBS       Node definition file.
  177.  
  178.         DOOR.SYS        This file contains all of the users settings
  179.                         such as graphics, parity, baud rate, etc.
  180.  
  181.  
  182.  
  183. Assumed WWIV files:
  184. ===================
  185.  
  186. Opinion assumes that the following files are in the directory specified
  187. by the path parameter when running directly under WWIV:
  188.  
  189.         NODES.BBS       Node definition file.
  190.  
  191.         CHAIN.TXT       This file contains all of the users settings
  192.                         such as graphics, parity, baud rate, etc.
  193.  
  194.  
  195.  
  196. Assumed Spitfire files:
  197. =======================
  198.  
  199. Opinion assumes that the following files are in the directory specified
  200. by the path parameter when running directly under Spitfire:
  201.  
  202.         NODES.BBS       Node definition file.
  203.  
  204.       * SFDOORS.DAT     This file contains all of the users settings
  205.                         such as graphics, parity, baud rate, etc.
  206.  
  207.       * SFMAIN.DAT      This file contains all of the users settings
  208.                         such as graphics, parity, baud rate, etc.
  209.  
  210.       * SFMESS.DAT      This file contains all of the users settings
  211.                         such as graphics, parity, baud rate, etc.
  212.  
  213.       * SFFILE.DAT      This file contains all of the users settings
  214.                         such as graphics, parity, baud rate, etc.
  215.  
  216. * Note only one of these files is required.  Will depend on the environment
  217. you select.
  218.  
  219.  
  220. SysOp controls:
  221. ===============
  222.  
  223. The SysOp has similar controls as to those provided in RBBS.  The following
  224. set of functions are available:
  225.  
  226.     Alt F1      This key will eject the current user from the game
  227.                 by setting all his door access time to consumed.
  228.  
  229.     Right Arrow This key will add 1 minute of door access time to
  230.                 the current users current door session.
  231.  
  232.     Left Arrow  This key will subtract 1 minute of door access time
  233.                 from the current users current door session.
  234.  
  235.         F4      The F4 key will toggle the state of the SysOp
  236.                 annoy toggle.  Note that it is reset to its
  237.                 original state when RBBS is reentered.
  238.  
  239.         F6      The F6 key will toggle the state of the SysOp
  240.                 availability toggle.  Note that it is reset to
  241.                 its original state when RBBS is reentered.
  242.  
  243.         F9      The F9 key will toggle the state of the SysOp
  244.                 snoop toggle.  Note that it is reset to its
  245.                 original state when RBBS is reentered.
  246.  
  247.         F10     The F10 key is used to initiate CHAT mode.  This
  248.                 allows the SysOp to converse with the user via the
  249.                 keyboard.
  250.  
  251.         ESC     The escape key is used to answer a user page.  It
  252.                 is also used to terminate CHAT mode.
  253.  
  254.  
  255. Epilog:
  256. =======
  257.  
  258. Please enjoy the program and feel free to contact Mycroft Systems BBS if
  259. you have any questions.
  260.  
  261.                                                 Thanks,
  262.  
  263.                                                 Michael W. Bayley
  264.                                                 Mycroft Systems
  265.                                                 (408)927-0105
  266.  
  267.